<?php
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/**
 *  Handles verification of gadget security tokens.
 */
abstract class SecurityTokenDecoder {

  /**
   * Decrypts and verifies a gadget security token to return a gadget token.
   * 
   * @param tokenString String representation of the token to be created.
   * @return The token representation of the input data.
   * @throws GadgetException If tokenString is not a valid token
   */
  abstract public function createToken($tokenString);
}
